fix(openapi-fetch): don't rely on DOM types #1827
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 19887b0 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
ngraef
commented
Aug 7, 2024
| @@ -24,7 +24,7 @@ export interface ClientOptions extends Omit<RequestInit, "headers"> { | |||
| } | |||
|
|
|||
| export type HeadersOptions = | |||
| | HeadersInit | |||
| | Required<RequestInit>["headers"] | |||
There was a problem hiding this comment.
This change pulls a reference to HeadersInit from RequestInit rather than relying on the global declaration, which only exists in the DOM lib. In projects with the DOM lib, this reference will resolve to HeadersInit declared in lib.dom.d.ts. In projects with Node types and no DOM lib, this reference will resolve to HeadersInit from undici-types/fetch.d.ts as referenced from @types/node/globals.d.ts.
drwpow
approved these changes
Aug 7, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
This PR changes typing to avoid the global
HeadersInit, which is declared in the DOM lib and therefore typically not included in Node projects.Resolves #1823
Resolves #1824
Resolves #1735
How to Review
How can a reviewer review your changes? What should be kept in mind for this review?
Checklist
docs/updated (if necessary)pnpm run update:examplesrun (only applicable for openapi-typescript)